/*
 * Copyright (c) 2013, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.omorphdb.core.index.sorted;

import java.util.List;

import org.omorphdb.core.index.ChainedIndex;
import org.omorphdb.core.value.Value;

/**
 * This interface should be implemented by some index, providing sorted search
 * functionality.
 * 
 * @param <T>
 */
public interface SortedIndex<T> extends ChainedIndex<T>
{
	/**
	 * Returns a list of document positions whose archive key value is greater
	 * than the provided key.
	 * 
	 * @param key
	 * @param inclusive When true, equal keys are considered.
	 * @return
	 */
	List<Long> getGreaterThan(Value<T> key, boolean inclusive);

	/**
	 * Returns a list of document positions whose archive key value is lesser
	 * than the provided key.
	 * 
	 * @param key
	 * @param inclusive When true, equal keys are considered.
	 * @return
	 */
	List<Long> getLesserThan(Value<T> key, boolean inclusive);
}
